Cards

Cards are a common organizing unit for modern user interfaces (UI). At their core, they’re just rectangular containers with borders and padding. However, when utilized properly to group related information, they help users better digest, engage, and navigate through content. This is why most successful dashboard/UI frameworks make cards a core feature of their component library. This article provides an overview of the API that bslib provides to create Bootstrap cards.

Setup code

To demonstrate that bslib cards work outside of Shiny (i.e., in R Markdown, static HTML, etc), we’ll make repeated use of statically rendered htmlwidgets like plotly and leaflet. Here’s some code to create those widgets:

library(bslib)
library(shiny)
library(htmltools)
library(plotly)
library(leaflet)

plotly_widget <- plot_ly(x = diamonds$cut) %>%
  config(displayModeBar = FALSE) %>%
  layout(margin = list(t = 0, b = 0, l = 0, r = 0))

leaflet_widget <- leafletOptions(attributionControl = FALSE) %>%
  leaflet(options = .) %>%
  addTiles()

Shiny usage

Cards work equally well in Shiny. In the examples below, replace plotly_widget with plotlyOutput() and leaflet_widget with leafletOutput() to adapt them for Shiny server-rendered plots/maps.

Hello `card()`

A card() is designed to handle any number of “known” card items (e.g., card_header(), card_body(), etc) as unnamed arguments (i.e., children). As we’ll see shortly, card() also has some useful named arguments (e.g., full_screen, height, etc).

At their core, card() and card items are just an HTML div() with a special Bootstrap class, so you can use Bootstrap’s utility classes to customize things like colors, text, borders, etc.

card(
  card_header(
    class = "bg-dark",
    "A header"
  ),
  card_body(
    markdown("Some text with a [link](https://github.com)")
  )
)

A header

Some text with a link

Implicit `card_body()`

If you find yourself using card_body() without changing any of its defaults, consider dropping it altogether since any direct children of card() that aren’t “known” card() items, are wrapped together into an implicit card_body() call.¹ For example, the code to the right generates HTML that is identical to the previous example:

card(
  card_header(
    class = "bg-dark",
    "A header"
  ),
  markdown("Some text with a [link](https://github.com).")
)

A header

Some text with a link.

Restricting growth

By default, a card()’s size grows to accommodate the size of it’s contents. Thus, if a card_body() contains a large amount of text, tables, etc., you may want to specify a height or max_height. That said, when laying out multiple cards, it’s likely best not to specify height on the card(), and instead, let the layout determine the height layout_column_wrap().

Although scrolling is convenient for reducing the amount of space required to park lots of content, it can also be a nuisance to the user. To help reduce the need for scrolling, consider pairing scrolling with full_screen = TRUE (which adds an icon to expand the card’s size to the browser window). Notice how, when the card is expanded to full-screen, max_height/height won’t effect the full-screen size of the card.

card(
  max_height = 250,
  full_screen = TRUE,
  card_header(
    "A long, scrolling, description"
  ),
  lorem::ipsum(paragraphs = 3, sentences = 5)
)

A long, scrolling, description

Adipiscing integer dictum cursus diam: fusce congue leo suscipit dapibus. Torquent dis ante luctus proin volutpat purus et nec facilisi? Tincidunt torquent nam sociosqu vehicula leo feugiat fames sapien cras sociis class ad rhoncus ridiculus! Mattis sagittis massa molestie tincidunt vitae libero, ultricies aenean metus fringilla primis massa. Arcu tellus.

Sit potenti convallis erat faucibus vitae; lectus ante bibendum luctus. Suscipit donec mollis aptent nascetur commodo? Inceptos dignissim scelerisque sodales, porttitor lacus ac suspendisse molestie. Ligula iaculis auctor, duis auctor donec natoque sociosqu semper placerat sem. Vehicula semper sociis, mauris phasellus lacinia curabitur pharetra, sociosqu scelerisque parturient posuere nisi.

Dolor maecenas dapibus euismod donec conubia, parturient condimentum faucibus, lectus lectus viverra. Aptent senectus aptent interdum, fringilla odio primis suscipit, ligula tristique. Pellentesque feugiat pulvinar condimentum cursus libero, penatibus semper – a ac montes quam egestas! Conubia viverra hac scelerisque, sem dictum non aliquet quam. Augue urna gravida, taciti bibendum blandit donec senectus metus nam.

Filling outputs

A card()’s default behavior is optimized for facilitating filling layouts. More specifically, if a fill item (e.g., plotly_widget), appears as a direct child of a card_body(), it resizes to fit the card()s specified height. This means, by specifying height = 250 we’ve effectively shrunk the plot’s height from its default of 400 down to about 200 pixels. And, when expanded to full_screen, the plot grows to match the card()’s new size.

card(
  height = 250,
  full_screen = TRUE,
  card_header("A filling plot"),
  card_body(plotly_widget)
)

A filling plot

Most htmlwidgets (e.g., plotly, leaflet, etc) and some other Shiny output bindings (e.g, plotOutput(), imageOutput(), etc) are fill items by default, so this behavior “just works” in those scenarios. And, in some of these situations, it’s helpful to remove card_body()’s padding, which can be done via spacing & alignment utility classes.

card(
  height = 275,
  full_screen = TRUE,
  card_header("A filling map"),
  card_body(
    class = "p-0",
    leaflet_widget
  ),
  card_footer(
    class = "fs-6",
    "Copyright 2023 RStudio, PBC"
  )
)

A filling map

Fill item(s) aren’t limited in how much they grow and shrink, which can be problematic when a card becomes very small. To work around this, consider adding a min_height on the card_body() container. For example, try using the handle on the lower-right portion of this card example to make the card taller/smaller.

This interactive example is a bit contrived in that we’re using CSS resize to demonstrate how to make plots that don’t shrink beyond a certain point, but this concept becomes quite useful when implementing page-level filling layouts (i.e., page_fillable()) with multiple cards.

card(
  height = 300,
  style = "resize:vertical;",
  card_header("Plots that grow but don't shrink"),
  card_body(
    min_height = 250,
    plotly_widget,
    plotly_widget
  )
)

Plots that grow but don't shrink

Troubleshooting fill

As you’ll learn more about in filling layouts, a fill item loses its ability to fill when wrapped in additional UI element that isn’t a fillable container. To fix the situation, use as_fill_carrier() to allow the additional element to carry the potential to fill from the card_body() down to the fill item.

Multiple `card_body()`

A card() can have multiple card_body()s, which is especially useful for:

Combining both resizable and non-resizable contents (i.e., fill items and non-fill).
Allowing each card_body() to have their own styling (via inline styles and/or utility classes) and resizing limits (e.g., min_height).

For example, when pairing filling output with scrolling content, you may want min_height on the filling output since the scrolling content will force it to shrink:

card(
  height = 375,
  full_screen = TRUE,
  card_header(
    "Filling plot, scrolling description"
  ),
  card_body(
    min_height = 200,
    plotly_widget
  ),
  card_body(
    class = "lead container",
    lorem::ipsum(paragraphs = 10, sentences = 5)
  )
)

Filling plot, scrolling description

Elit conubia nec, at lacus venenatis id, nisl pellentesque porta habitasse nibh? Nulla arcu vivamus phasellus blandit posuere risus nullam inceptos massa suspendisse placerat sagittis. Condimentum erat imperdiet taciti, ullamcorper diam etiam eros class – aenean, dui sagittis conubia. A bibendum hendrerit quam justo, per nisl vel magna pulvinar quisque inceptos. Na inceptos!

Lorem facilisi donec etiam interdum mauris gravida tellus congue nascetur; consequat mattis praesent bibendum aenean volutpat cubilia. Enim sociis semper parturient sem condimentum potenti ligula, placerat convallis viverra quis. Cras luctus massa, sed hac, mattis, feugiat neque himenaeos. Vitae odio phasellus parturient turpis egestas commodo, lectus lacus blandit ultrices. Ultrices vestibulum.

Consectetur sagittis vehicula non porta pharetra. Porta congue quis, urna pretium sociosqu mus per tempor. Consequat urna fermentum sapien accumsan nec facilisi; aliquet dui senectus. Porta sollicitudin duis sollicitudin ligula vel sapien sem scelerisque tempor non? Risus mauris non sodales vel habitant dis nisi semper hendrerit: tempor lacus, praesent cum facilisi!

Elit cras nullam inceptos himenaeos nisi magna dui tristique? Inceptos dictumst tincidunt augue tempor vitae eget nam facilisis porttitor fringilla? Habitasse cubilia nascetur suscipit egestas metus congue. Mi himenaeos odio duis auctor, viverra in taciti etiam. Cum tellus dis scelerisque inceptos lacus mus rutrum eros.

Lorem augue auctor cras venenatis velit ut semper; nullam egestas himenaeos. Ad hac pharetra blandit id blandit penatibus. Inceptos etiam pretium, turpis; mi maecenas morbi rutrum nunc cursus tortor. Aenean torquent tempor – feugiat congue odio tempus – rutrum nec integer arcu posuere nunc. Velit habitasse hac dictum phasellus, torquent fringilla?

Consectetur ligula enim natoque sociosqu, nunc, parturient dui elementum vivamus nostra justo ultrices. Aliquam tincidunt commodo per suspendisse nostra ad tempor, faucibus lectus semper interdum at. Erat inceptos tellus magna turpis molestie: risus sociis quisque, aliquet aliquam? Auctor nulla varius rhoncus elementum eros! Netus venenatis dignissim aliquet penatibus fermentum himenaeos habitant?

Amet semper vivamus interdum malesuada: parturient fames odio, curabitur mi! Donec habitasse, aptent, nam purus rhoncus praesent mus mi – fames malesuada. Curabitur malesuada congue sed suspendisse blandit quisque: tellus quisque faucibus. Molestie sagittis hendrerit dignissim, ridiculus class eu eu platea elementum porta aliquet. Na aliquet.

Lorem condimentum rhoncus orci – inceptos litora mattis ligula varius. Tristique in hendrerit, tincidunt, dignissim cubilia malesuada. Pretium varius imperdiet aptent luctus mollis, tempor dui, egestas augue malesuada? Vel habitant nisi platea auctor litora: litora ultrices! Et mattis porttitor viverra fringilla eleifend vulputate convallis pharetra augue integer hac ad libero: blandit fames enim nullam urna ad suspendisse volutpat.

Dolor habitant natoque feugiat curabitur, fames orci sagittis luctus. Primis mus euismod; nullam sodales erat – inceptos enim, auctor ultricies? Egestas integer etiam morbi vulputate urna, dapibus suscipit, senectus imperdiet. Odio vestibulum non sapien dignissim nullam himenaeos ultricies, aliquam dictum auctor vulputate. Lacinia a.

Amet proin vitae non – aliquam hendrerit ad etiam. Dis eget dignissim conubia, congue integer feugiat phasellus. Habitant dapibus donec gravida auctor potenti etiam est. A sem quisque cras vel est tristique quisque fringilla taciti tristique. Ante ac fames auctor luctus eleifend, pretium ridiculus blandit sodales rutrum conubia ac tellus integer aliquet pellentesque cras eu ligula!

Also, when the content has a fixed size, and should not be allowed to scroll, set fill = FALSE:

card(
  height = 350,
  full_screen = TRUE,
  card_header(
    "Filling plot, short description"
  ),
  plotly_widget,
  card_body(
    fill = FALSE,
    card_title("A subtitle"),
    p(class = "text-muted", "And a caption")
  )
)

Filling plot, short description

A subtitle

And a caption

Multiple columns

As you’ll learn in column-based layouts, layout_column_wrap() is great for multi-column layouts that are responsive and accommodate for filling output. Here we have an equal-width 2-column layout using width = 1/2, but it’s also possible to have varying column widths.

card(
  height = 350,
  full_screen = TRUE,
  card_header("A multi-column filling layout"),
  card_body(
    min_height = 200,
    layout_column_wrap(
      width = 1/2,
      plotOutput("p1"),
      plotOutput("p2")
    )
  ),
  lorem::ipsum(paragraphs = 3, sentences = 5)
)

A multi-column filling layout

Dolor curabitur urna fermentum est nullam tristique enim phasellus habitant mollis. Potenti iaculis natoque pellentesque vehicula semper est pharetra. Curabitur velit vel suscipit eros vitae nisi felis: habitant proin tortor cum parturient, curae netus! Natoque aliquam commodo bibendum tellus mollis – phasellus, feugiat in quis suspendisse. Venenatis consequat taciti eros!

Elit habitasse posuere aenean nam tellus risus: pellentesque: tempus vel ultrices congue faucibus magnis eleifend. Aliquam ultrices vitae hac inceptos ut dictumst – ligula porta venenatis convallis in. Purus ornare maecenas scelerisque imperdiet, auctor massa orci, aptent, risus fermentum. Nisl venenatis vitae tempor enim imperdiet. Id scelerisque metus phasellus auctor est porttitor libero ornare condimentum cursus?

Ipsum sed suspendisse viverra sodales pellentesque tempus tempor posuere morbi. Maecenas lacus tempus nec montes torquent eleifend feugiat magna senectus pellentesque: porta facilisi turpis! Integer mus ultricies eget blandit pellentesque dui velit iaculis. Neque condimentum cubilia dictum posuere molestie nascetur cum aptent euismod primis dis litora ut class nisi massa. Netus nascetur facilisi, blandit arcu, laoreet faucibus imperdiet rhoncus convallis senectus dictum!

Multiple cards

layout_column_wrap() is especially nice for laying out multiple cards since each card in a particular row will have the same height (by default). Learn more in column-based layouts.

layout_column_wrap(
  width = 1/2,
  height = 300,
  card(full_screen = TRUE, card_header("A filling plot"), plotly_widget),
  card(full_screen = TRUE, card_header("A filling map"), card_body(class = "p-0", leaflet_widget))
)

A filling plot

A filling map

Multiple tabs

navset_card_tab() and navset_card_pill() make it possible to create cards with multiple tabs or pills. These functions have the same full_screen capabilities as normal card()s as well some other options like title (since there is no natural place for a card_header() to be used). Note that, each nav_panel() object is similar to a card(). That is, if the direct children aren’t already card items (e.g., card_title()), they get implicitly wrapped in a card_body().

library(leaflet)
navset_card_tab(
  height = 450,
  full_screen = TRUE,
  title = "HTML Widgets",
  nav_panel(
    "Plotly",
    card_title("A plotly plot"),
    plotly_widget
  ),
  nav_panel(
    "Leaflet",
    card_title("A leaflet plot"),
    leaflet_widget
  ),
  nav_panel(
    shiny::icon("circle-info"),
    markdown("Learn more about [htmlwidgets](http://www.htmlwidgets.org/)")
  )
)

HTML Widgets

Plotly
Leaflet

A plotly plot

A leaflet plot

Learn more about htmlwidgets

Sidebars

As you’ll learn more about in sidebar layouts, layout_sidebar() just works when placed inside in a card(). In this case, if you want fill items (e.g., plotly_widget) to still fill the card like we’ve seen before, you’ll need to set fillable = TRUE in layout_sidebar().

card(
  height = 300,
  full_screen = TRUE,
  card_header("A sidebar layout inside a card"),
  layout_sidebar(
    fillable = TRUE,
    sidebar = sidebar(
      actionButton("btn", "A button")
    ),
    plotly_widget
  )
)

A sidebar layout inside a card

Static images

card_image() makes it easy to embed static (i.e., pre-generated) images into a card. Provide a URL to href to make it clickable. In the case of multiple card_image()s, consider laying them out in multiple cards with layout_column_wrap() to produce a grid of clickable thumbnails.

card(
  height = 300,
  full_screen = TRUE,
  card_image(
    file = "shiny-hex.svg",
    href = "https://github.com/rstudio/shiny"
  ),
  card_body(
    fill = FALSE,
    card_title("Shiny for R"),
    p(
      class = "fw-light text-muted",
      "Brought to you by RStudio."
    )
  )
)

Shiny for R

Brought to you by RStudio.

Flexbox

Both card() and card_body() default to fillable = TRUE (that is, they are CSS flexbox containers), which works wonders for facilitating filling outputs, but it also leads to surprising behavior with inline tags (e.g., actionButton(), span(), strings, etc). Specifically, each inline tag is placed on a new line, but in a “normal” layout flow (fillable = FALSE), inline tags render inline.

card(
  card_body(
    fillable = TRUE,
    "Here's some", tags$i("inline"), "text",
    actionButton("btn1", "A button")
  ),
  card_body(
    fillable = FALSE,
    "Here's some", tags$i("inline"), "text",
    actionButton("btn2", "A button")
  )
)

Here's some inline text

That said, sometimes working in a flexbox layout is quite useful, even when working with inline tags. Here we leverage flexbox’s gap property to control the spacing between a plot, a (full-width) button, and paragraph. Note that, by using markdown() for the paragraph, it wraps the results in a <p> tag, which means the contents of the paragraph are not longer subject to flexbox layout. If we wanted, we could do something similar to render the actionButton() inline by wrapping it in a div().

card(
  height = 325, full_screen = TRUE,
  card_header("A plot with an action links"),
  card_body(
    class = "gap-2 container",
    plotly_widget,
    actionButton(
      "go_btn", "Action button",
      class = "btn-primary rounded-0"
    ),
    markdown("Here's a _simple_ [hyperlink](https://www.google.com/).")
  )
)

A plot with an action links

Here's a simple hyperlink.

In addition to gap, flexbox has really nice ways of handling otherwise difficult spacing and alignment issues. And, thanks to Bootstrap’s flex utility classes, we can easily opt-in and customize defaults.

card(
  height = 300, full_screen = TRUE,
  card_header(
    class = "d-flex justify-content-between",
    "Centered plot",
    checkboxInput("check", " Check me", TRUE)
  ),
  card_body(
    class = "align-items-center",
    plotOutput("id", width = "75%")
  )
)

Centered plot

Check me

Shiny

Since this article is statically rendered, the examples here use statically rendered content/widgets, but the same card() functionality works for dynamically rendered content via Shiny (e.g., plotOutput(), plotlyOutput(), etc).

An additional benefit that comes with using shiny is the ability to use getCurrentOutputInfo() to render new/different content when the output container becomes large enough, which is particularly useful with card(full_screen = T, ...). For example, you may want additional captions/labels when a plot is large, additional controls on a table, etc (see the value boxes article for a clever use of this).

# UI logic
ui <- page_fluid(
  card(
    max_height = 200,
    full_screen = TRUE,
    card_header("A dynamically rendered plot"),
    plotOutput("plot_id")
  )
)

# Server logic
server <- function(input, output, session) {
  output$plot_id <- renderPlot({
    info <- getCurrentOutputInfo()
    if (info$height() > 600) {
      # code for "large" plot
    } else {
      # code for "small" plot
    }
  })
}

shinyApp(ui, server)

Appendix

The following CSS is used to give plotOutput() a background color; it’s necessary here because this documentation page is not actually hooked up to a Shiny app, so we can’t show a real plot.

.shiny-plot-output {
  background-color: #216B7288;
  height: 400px;
  width: 100%;
}